Skip to content

Docs: sync upstream clickhouse-operator docs updates#80

Closed
mintlify[bot] wants to merge 1 commit into
mainfrom
sync/clickhouse-operator-docs-20260527
Closed

Docs: sync upstream clickhouse-operator docs updates#80
mintlify[bot] wants to merge 1 commit into
mainfrom
sync/clickhouse-operator-docs-20260527

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 27, 2026

Summary

Syncs documentation updates from clickhouse/clickhouse-operator into products/kubernetes-operator/ to reflect the new additionalPorts ClickHouseCluster CRD field.

cc @GrigoryPervakov for review (author of upstream clickhouse-operator#197).

Changes

  • products/kubernetes-operator/reference/api-reference.mdx — adds the new AdditionalPort type section and the additionalPorts row in ClickHouseClusterSpec, copied verbatim from upstream commit 7e82242 ("feat: allow exposing additional ports on ClickHouse service and pods", #197).
  • products/kubernetes-operator/install/olm.mdx — trailing newline alignment with upstream.

Context

Upstream source commit: 7e82242af1ef32ec951ad5c6c88ff64b0e5299eb (PR #197).

Conflicts / issues

  • Pre-existing downstream link rewrites in guides/configuration.mdx and guides/introduction.mdx (/concepts/.../core/concepts/..., /reference/.../core/reference/...) were intentionally not overwritten — these are downstream-only path adjustments for this Mintlify site. No upstream content changes touched these files, so there is no real conflict; flagging only for visibility.
  • Upstream-only files (README.md, development.md, styles/, templates/) are not synced — they are not part of the published Mintlify docs.
  • Validation: mint validate passes. mint broken-links reports 2 unrelated pre-existing broken links in integrations/language-clients/java/jdbc.mdx (not caused by this sync).

Note

Low Risk
Documentation-only sync with no runtime, auth, or data-path changes.

Overview
Syncs clickhouse-operator upstream docs into products/kubernetes-operator/ so the published API reference matches the new additionalPorts CRD capability.

The api-reference.mdx page gains an AdditionalPort section (name, port) and documents ClickHouseClusterSpec.additionalPorts: extra TCP ports on ClickHouse pods and the operator headless Service, with a note that Kubernetes exposure does not by itself make ClickHouse listen on those ports. install/olm.mdx only picks up a trailing newline from upstream.

Reviewed by Cursor Bugbot for commit 28b7759. Bugbot is set up for automated code reviews on this repo. Configure here.

@Blargian Blargian closed this May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant